/************************************************************************
**
**  Copyright (C) 2009, 2010, 2011  Strahinja Markovic  <strahinja.markovic@gmail.com>
**
**  This file is part of Sigil.
**
**  Sigil is free software: you can redistribute it and/or modify
**  it under the terms of the GNU General Public License as published by
**  the Free Software Foundation, either version 3 of the License, or
**  (at your option) any later version.
**
**  Sigil is distributed in the hope that it will be useful,
**  but WITHOUT ANY WARRANTY; without even the implied warranty of
**  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**  GNU General Public License for more details.
**
**  You should have received a copy of the GNU General Public License
**  along with Sigil.  If not, see <http://www.gnu.org/licenses/>.
**
*************************************************************************/

#pragma once
#ifndef HTMLSPELLCHECK_H
#define HTMLSPELLCHECK_H

class HTMLSpellCheck
{

public:

    struct MisspelledWord 
    {
        QString text;
        int offset;
        int length;
    };

    static QList< MisspelledWord > GetMisspelledWords( const QString &text, 
                                                       int start_offset, 
                                                       int end_offset, 
                                                       const QString &search_regex, 
                                                       bool first_only = false );

    static QList< MisspelledWord > GetMisspelledWords( const QString &text );

    static int CountMisspelledWords( const QString &text, 
                                     int start_offset, 
                                     int end_offset, 
                                     const QString &search_regex );

    static int CountMisspelledWords( const QString &text );

    static MisspelledWord GetFirstMisspelledWord( const QString &text, 
                                                  int start_offset, 
                                                  int end_offset, 
                                                  const QString &search_regex );

    static MisspelledWord GetLastMisspelledWord( const QString &text, 
                                                 int start_offset, 
                                                 int end_offset, 
                                                 const QString &search_regex );

private:

    static bool IsBoundary( QChar prev_c, QChar c, QChar next_c, bool in_entity );

};

#endif // HTMLSPELLCHECK_H
